Trial handling: additional functionality and documentation#673
Open
kohlerca wants to merge 42 commits intoNeuralEnsemble:masterfrom
Open
Trial handling: additional functionality and documentation#673kohlerca wants to merge 42 commits intoNeuralEnsemble:masterfrom
kohlerca wants to merge 42 commits intoNeuralEnsemble:masterfrom
Conversation
added 30 commits
June 18, 2025 17:42
…piketrain across trials
…s.py to trials.py. GPFA methods and unit tests adjusted.
…s are accessed by indexes (instead of ambiguous terms ID or number). Added deprecations with warning decorator and corresponding unit tests.
…specific value checks
added 7 commits
October 3, 2025 00:14
Collaborator
kohlerca
added
enhancement
| individual data of each trial. | ||
|
|
||
| The classes of this module abstract from these specific data representations | ||
| by introducing a set of :class:`Trials` classes with a common API. These |
Contributor
There was a problem hiding this comment.
While working on instantaneous_rate fix PR #649 , I noticed that sphinx doesn't create a link for :class:Trials . Further check on RTD seems to reveal there is no page for this base class? dedicated pages only exist for the subclasses (e.g. TrailsFromBlocks etc..).
Should we leave this as is, add a page for the base class, or link to the existing Trials documentation wherever a reference is needed(e.g. in statistics.py etc..)?
Contributor
There was a problem hiding this comment.
One fix i tried out is using the :mod: cross referencing, so this takes us to the right module page. So for trials one lands on the trials page, from there TrailsFromBlocks or the other one can be selected.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is a revision of the existing
Trialsobjects. Several improvements are implemented:Functionality
get_spiketrains_trial_by_trialandget_analogsignals_trial_by_trial).Trials, for improved maintenance.trial_index), instead of the previoustrial_idortrial_number.Documentation
TrialsFromBlockandTrialsFromList.TODOs